Add Swagger UI API documentation with OpenAPI 3.0#25
Draft
Copilot wants to merge 2 commits into
Draft
Conversation
Co-authored-by: Wingysam <18403742+Wingysam@users.noreply.github.com>
Deploying galaxy-info-v2 with
|
| Latest commit: |
2c7265b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://366be75c.galaxy-info-v2.pages.dev |
| Branch Preview URL: | https://copilot-add-api-documentatio.galaxy-info-v2.pages.dev |
Copilot
AI
changed the title
[WIP] Add API documentation with Swagger UI
Add Swagger UI API documentation with OpenAPI 3.0
Jan 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Implements interactive API documentation using Swagger UI to replace manual documentation maintenance. All v2 API endpoints are now self-documented through JSDoc annotations.
Changes
/api-docsendpoint serving Swagger UI with OpenAPI 3.0 specx-tokenheader and query parameterImplementation
OpenAPI spec generated from JSDoc comments in route handlers:
Swagger UI route configured before authentication middleware to allow public access to documentation.
Access
Documentation available at
/api-docswhen server is running.Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
checkpoint.prisma.io/usr/local/bin/node /usr/local/bin/node /home/REDACTED/work/Galaxy-Info-v2/Galaxy-Info-v2/server/node_modules/prisma/build/child {"product":"prisma","version":"6.6.0","cli_install_type":"local","information":"","local_timestamp":"2026-01-02T16:18:07Z","project_hash":"f62ce0e9","cli_path":"/home/REDACTED/work/Galaxy-Info-v2/Galaxy-Info-v2/server/node_modules/.bin/prisma","cli_path_has(dns block)/usr/local/bin/node /usr/local/bin/node /home/REDACTED/work/Galaxy-Info-v2/Galaxy-Info-v2/server/node_modules/prisma/build/child {"product":"prisma","version":"6.6.0","cli_install_type":"local","information":"","local_timestamp":"2026-01-02T16:18:08Z","project_hash":"f62ce0e9","cli_path":"/home/REDACTED/work/Galaxy-Info-v2/Galaxy-Info-v2/server/node_modules/.bin/prisma","cli_path_has(dns block)wiki.galaxy.casa/usr/local/bin/node node /home/REDACTED/work/Galaxy-Info-v2/Galaxy-Info-v2/server/node_modules/.bin/jest(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.